/*
 * Copyright 2021 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.netty5.buffer.internal;

import io.netty5.buffer.AllocationType;
import io.netty5.util.internal.UnstableApi;

/**
 * An {@link AllocationType} for on-heap buffer allocations that wrap an existing byte array.
 */
@SuppressWarnings("AssignmentOrReturnOfFieldWithMutableType") // This is the express purpose of this class.
@UnstableApi
public final class WrappingAllocation implements AllocationType {
    private final byte[] array;

    public WrappingAllocation(byte[] array) {
        this.array = array;
    }

    public byte[] getArray() {
        return array;
    }

    @Override
    public boolean isDirect() {
        return false;
    }

    @Override
    public String toString() {
        return "WrappingAllocation(byte[" + array.length + "])";
    }
}
